Skip to main content

Using Markdown

All the documentation on this site is written in Markdown. (.md) Markdown allows you to specify text formatting in document.

Frontmatter​

Each Markdown file starts with something that looks like this:

---
sidebar_position: 2
scope: public
---

This is called frontmatter, and you can set properties that control how the document will be seen on the site.

Here, we have set this document to be the second tab in the sidebar by setting sidebar_position: 2 The spelling and capitalization of these variables is important, and must match exactly.

Scope​

Another property you can set is scope. Scope controls who can see the document. If a scope property is not set, the document is not visible on the website. If scope is set to public, the document is visible to anyone who visits the site. You can also scope documents to certain organizations. If you set scope: example.com, then only members of the domain example.com would be able to view the document. Scoped documents are only visible to signed in users.

Formatting​

Markdown allows you to create headings, tables, and many other layout elements.

ElementMarkdown Syntax
Heading
# H1
## H2
### H3
Bold**bold text**
Italic*italicized text*
Blockquote> blockquote
Ordered List
1. First item
2. Second item
3. Third item
Unordered List
- First item
- Second item
- Third item
Code`code`
Horizontal Rule---
Link[title](https://www.example.com)
Image![alt text](image.jpg)

Markdown also supports HTML. For more information about Markdown formatting, see here.